home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 April / CHIP CD (4 - 2007).iso / admin / secure / wireshark-setup-0.99.5.exe / snmp / mibs / NET-SNMP-AGENT-MIB.txt < prev    next >
Encoding:
Text File  |  2005-02-08  |  15.4 KB  |  551 lines
  1. NET-SNMP-AGENT-MIB DEFINITIONS ::= BEGIN
  2.  
  3. --
  4. -- Defines control and monitoring structures for the Net-SNMP agent.
  5. --
  6.  
  7. IMPORTS
  8.     SnmpAdminString
  9.         FROM SNMP-FRAMEWORK-MIB
  10.  
  11.     netSnmpObjects, netSnmpModuleIDs, netSnmpNotifications, netSnmpGroups
  12.     FROM NET-SNMP-MIB
  13.  
  14.     OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY, Integer32, Unsigned32
  15.         FROM SNMPv2-SMI
  16.  
  17.     OBJECT-GROUP, NOTIFICATION-GROUP
  18.     FROM SNMPv2-CONF
  19.  
  20.     TEXTUAL-CONVENTION, DisplayString, RowStatus, TruthValue
  21.     FROM SNMPv2-TC;
  22.  
  23.  
  24. netSnmpAgentMIB MODULE-IDENTITY
  25.     LAST-UPDATED "200502070000Z"
  26.     ORGANIZATION "www.net-snmp.org"
  27.     CONTACT-INFO    
  28.      "postal:   Wes Hardaker
  29.                     P.O. Box 382
  30.                     Davis CA  95617
  31.  
  32.           email:    net-snmp-coders@lists.sourceforge.net"
  33.     DESCRIPTION
  34.      "Defines control and monitoring structures for the Net-SNMP agent."
  35.     REVISION     "200502070000Z"
  36.     DESCRIPTION
  37.         "Fixing syntax errors"
  38.     REVISION     "200202090000Z"
  39.     DESCRIPTION
  40.     "First revision."
  41.     ::= { netSnmpModuleIDs 2 }
  42.  
  43.  
  44. nsVersion              OBJECT IDENTIFIER ::= {netSnmpObjects 1}
  45. nsMibRegistry          OBJECT IDENTIFIER ::= {netSnmpObjects 2}
  46. nsExtensions           OBJECT IDENTIFIER ::= {netSnmpObjects 3}
  47. nsDLMod                OBJECT IDENTIFIER ::= {netSnmpObjects 4}
  48. nsCache                OBJECT IDENTIFIER ::= {netSnmpObjects 5}
  49. nsErrorHistory         OBJECT IDENTIFIER ::= {netSnmpObjects 6}
  50. nsConfiguration        OBJECT IDENTIFIER ::= {netSnmpObjects 7}
  51. nsTransactions         OBJECT IDENTIFIER ::= {netSnmpObjects 8}
  52.  
  53. --
  54. --  MIB Module data caching management
  55. --
  56.  
  57. NetsnmpCacheStatus ::= TEXTUAL-CONVENTION
  58.     STATUS      current
  59.     DESCRIPTION "an indication of the status of data caching entries"
  60.     SYNTAX INTEGER {
  61.         enabled(1),
  62.         disabled(2),
  63.         empty  (3),
  64.         cached (4),
  65.         expired(5)
  66.            }
  67.  
  68. nsCacheDefaultTimeout         OBJECT-TYPE
  69.     SYNTAX      INTEGER        -- ???
  70.     MAX-ACCESS  read-write
  71.     STATUS      current
  72.     DESCRIPTION
  73.       "Default cache timeout value (unless overridden
  74.        for a particular cache entry)."
  75.     DEFVAL { 5 --seconds-- }
  76.     ::= { nsCache 1 }
  77.  
  78. nsCacheEnabled                OBJECT-TYPE
  79.     SYNTAX      TruthValue
  80.     MAX-ACCESS  read-write
  81.     STATUS      current
  82.     DESCRIPTION
  83.       "Whether data caching is active overall."
  84.     DEFVAL { true }
  85.     ::= { nsCache 2 }
  86.  
  87. nsCacheTable     OBJECT-TYPE
  88.     SYNTAX      SEQUENCE OF NsCacheEntry
  89.     MAX-ACCESS  not-accessible
  90.     STATUS      current
  91.     DESCRIPTION
  92.       "A table of individual MIB module data caches."
  93.     ::= { nsCache 3 }
  94.  
  95. nsCacheEntry     OBJECT-TYPE
  96.     SYNTAX      NsCacheEntry
  97.     MAX-ACCESS  not-accessible
  98.     STATUS      current
  99.     DESCRIPTION
  100.       "A conceptual row within the cache table."
  101.     INDEX       { IMPLIED nsCachedOID }
  102.     ::= { nsCacheTable 1 }
  103.  
  104. NsCacheEntry ::= SEQUENCE {
  105.     nsCachedOID     OBJECT IDENTIFIER,
  106.     nsCacheTimeout  INTEGER,        -- ?? TimeTicks ??
  107.     nsCacheStatus   NetsnmpCacheStatus    -- ?? INTEGER ??
  108. }
  109.  
  110. nsCachedOID     OBJECT-TYPE
  111.     SYNTAX      OBJECT IDENTIFIER
  112.     MAX-ACCESS  not-accessible
  113.     STATUS      current
  114.     DESCRIPTION
  115.       "The root OID of the data being cached."
  116.     ::= { nsCacheEntry 1 }
  117.  
  118. nsCacheTimeout  OBJECT-TYPE
  119.     SYNTAX      INTEGER
  120.     MAX-ACCESS  read-write
  121.     STATUS      current
  122.     DESCRIPTION
  123.       "The length of time (?in seconds) for which the data in
  124.        this particular cache entry will remain valid." 
  125.     ::= { nsCacheEntry 2 }
  126.  
  127. nsCacheStatus   OBJECT-TYPE
  128.     SYNTAX      NetsnmpCacheStatus
  129.     MAX-ACCESS  read-write
  130.     STATUS      current
  131.     DESCRIPTION
  132.       "The current status of this particular cache entry.
  133.        Acceptable values for Set requests are 'enabled(1)',
  134.        'disabled(2)' or 'empty(3)' (to clear all cached data).
  135.        Requests to read the value of such an object will
  136.        return 'disabled(2)' through to 'expired(5)'."
  137.     ::= { nsCacheEntry 3 }
  138.  
  139. --
  140. --  Agent configuration
  141. --    Debug and logging output
  142. --
  143.  
  144. nsConfigDebug          OBJECT IDENTIFIER ::= {nsConfiguration 1}
  145. nsConfigLogging        OBJECT IDENTIFIER ::= {nsConfiguration 2}
  146.  
  147. nsDebugEnabled         OBJECT-TYPE
  148.     SYNTAX      TruthValue
  149.     MAX-ACCESS  read-write
  150.     STATUS      current
  151.     DESCRIPTION
  152.       "Whether the agent is configured to generate debugging output"
  153.     DEFVAL { false }
  154.     ::= { nsConfigDebug 1 }
  155.  
  156. nsDebugOutputAll       OBJECT-TYPE
  157.     SYNTAX      TruthValue
  158.     MAX-ACCESS  read-write
  159.     STATUS      current
  160.     DESCRIPTION
  161.       "Whether the agent is configured to display all debugging output
  162.        rather than filtering on individual debug tokens.  Nothing will
  163.        be generated unless nsDebugEnabled is also true(1)"
  164.     DEFVAL { false }
  165.     ::= { nsConfigDebug 2 }
  166.  
  167. nsDebugDumpPdu        OBJECT-TYPE
  168.     SYNTAX      TruthValue
  169.     MAX-ACCESS  read-write
  170.     STATUS      current
  171.     DESCRIPTION
  172.       "Whether the agent is configured to display raw packet dumps.
  173.        This is unrelated to the nsDebugEnabled setting."
  174.     DEFVAL { false }
  175.     ::= { nsConfigDebug 3 }
  176.  
  177. nsDebugTokenTable     OBJECT-TYPE
  178.     SYNTAX      SEQUENCE OF NsDebugTokenEntry
  179.     MAX-ACCESS  not-accessible
  180.     STATUS      current
  181.     DESCRIPTION
  182.       "A table of individual debug tokens, used to control the selection
  183.        of what debugging output should be produced.  This table is only
  184.        effective if nsDebugOutputAll is false(2), and nothing will
  185.        be generated unless nsDebugEnabled is also true(1)"
  186.     ::= { nsConfigDebug 4 }
  187.  
  188. nsDebugTokenEntry     OBJECT-TYPE
  189.     SYNTAX      NsDebugTokenEntry
  190.     MAX-ACCESS  not-accessible
  191.     STATUS      current
  192.     DESCRIPTION
  193.       "A conceptual row within the debug token table."
  194.     INDEX       { IMPLIED nsDebugTokenPrefix }
  195.     ::= { nsDebugTokenTable 1 }
  196.  
  197. NsDebugTokenEntry ::= SEQUENCE {
  198.     nsDebugTokenPrefix  DisplayString,
  199.     nsDebugTokenStatus  RowStatus
  200. }
  201.  
  202. nsDebugTokenPrefix    OBJECT-TYPE
  203.     SYNTAX      DisplayString
  204.     MAX-ACCESS  not-accessible
  205.     STATUS      current
  206.     DESCRIPTION
  207.       "A token prefix for which to generate the corresponding
  208.        debugging output.  Note that debug output will be generated
  209.        for all registered debug statements sharing this prefix
  210.        (rather than an exact match).  Nothing will be generated
  211.        unless both nsDebuggingEnabled is set true(1) and the
  212.        corresponding nsDebugTokenStatus value is active(1)."
  213.     ::= { nsDebugTokenEntry 2 }
  214.  
  215. nsDebugTokenStatus   OBJECT-TYPE
  216.     SYNTAX      RowStatus
  217.     MAX-ACCESS  read-create
  218.     STATUS      current
  219.     DESCRIPTION
  220.       "Whether to generate debug output for the corresponding debug
  221.        token prefix.  Nothing will be generated unless both
  222.        nsDebuggingEnabled is true(1) and this instance is active(1).
  223.        Note that is valid for an instance to be left with the value
  224.        notInService(2) indefinitely - i.e. the meaning of 'abnormally
  225.        long' (see RFC 2579, RowStatus) for this table is infinite."
  226.     ::= { nsDebugTokenEntry 4 }
  227.  
  228. --
  229. -- Logging configuration
  230. --
  231.  
  232. nsLoggingTable     OBJECT-TYPE
  233.     SYNTAX      SEQUENCE OF NsLoggingEntry
  234.     MAX-ACCESS  not-accessible
  235.     STATUS      current
  236.     DESCRIPTION
  237.       "A table of individual logging output destinations, used to control
  238.        where various levels of output from the agent should be directed."
  239.     ::= { nsConfigLogging 1 }
  240.  
  241. nsLoggingEntry     OBJECT-TYPE
  242.     SYNTAX      NsLoggingEntry
  243.     MAX-ACCESS  not-accessible
  244.     STATUS      current
  245.     DESCRIPTION
  246.       "A conceptual row within the logging table."
  247.     INDEX       { nsLogLevel, IMPLIED nsLogToken }
  248.     ::= { nsLoggingTable 1 }
  249.  
  250. NsLoggingEntry ::= SEQUENCE {
  251.     nsLogLevel          INTEGER,
  252.     nsLogToken          DisplayString,
  253.     nsLogType           INTEGER,
  254.     nsLogMaxLevel       INTEGER,
  255.     nsLogStatus         RowStatus
  256. }
  257.  
  258. nsLogLevel    OBJECT-TYPE
  259.     SYNTAX      INTEGER {
  260.              emergency(0),
  261.              alert    (1),
  262.              critical (2),
  263.              error    (3),
  264.              warning  (4),
  265.              notice   (5),
  266.              info     (6),
  267.              debug    (7)
  268.                 }
  269.     MAX-ACCESS  not-accessible
  270.     STATUS      current
  271.     DESCRIPTION
  272.       "The (minimum) priority level for which this logging entry
  273.        should be applied."
  274.     ::= { nsLoggingEntry 1 }
  275.  
  276. nsLogToken    OBJECT-TYPE
  277.     SYNTAX      DisplayString
  278.     MAX-ACCESS  not-accessible
  279.     STATUS      current
  280.     DESCRIPTION
  281.       "A token for which to generate logging entries.
  282.        Depending on the style of logging, this may either
  283.        be simply an arbitrary token, or may have some
  284.        particular meaning (such as the filename to log to)."
  285.     ::= { nsLoggingEntry 2 }
  286.  
  287. nsLogType     OBJECT-TYPE
  288.     SYNTAX      INTEGER {
  289.              stdout   (1),
  290.              stderr   (2),
  291.              file     (3),
  292.              syslog   (4),
  293.              callback (5)
  294.                 }
  295.     MAX-ACCESS  read-create
  296.     STATUS      current
  297.     DESCRIPTION
  298.       "The type of logging for this entry."
  299.     ::= { nsLoggingEntry 3 }
  300.  
  301. nsLogMaxLevel OBJECT-TYPE
  302.     SYNTAX      INTEGER {
  303.              emergency(0),
  304.              alert    (1),
  305.              critical (2),
  306.              error    (3),
  307.              warning  (4),
  308.              notice   (5),
  309.              info     (6),
  310.              debug    (7)
  311.                 }
  312.     MAX-ACCESS  read-create
  313.     STATUS      current
  314.     DESCRIPTION
  315.       "The maximum priority level for which this logging entry
  316.        should be applied."
  317.     DEFVAL      { emergency }
  318.     ::= { nsLoggingEntry 4 }
  319.  
  320. nsLogStatus   OBJECT-TYPE
  321.     SYNTAX      RowStatus
  322.     MAX-ACCESS  read-create
  323.     STATUS      current
  324.     DESCRIPTION
  325.       "Whether to generate logging output for this entry.
  326.        Note that is valid for an instance to be left with the value
  327.        notInService(2) indefinitely - i.e. the meaning of 'abnormally
  328.        long' (see RFC 2579, RowStatus) for this table is infinite."
  329.     ::= { nsLoggingEntry 5 }
  330.  
  331. --
  332. --  Monitoring outstanding "transactions"
  333. --    (i.e. requests sent to AgentX subagents, or proxied agents)
  334. --
  335.  
  336. nsTransactionTable OBJECT-TYPE
  337.     SYNTAX      SEQUENCE OF NsTransactionEntry
  338.     MAX-ACCESS  not-accessible
  339.     STATUS      current
  340.     DESCRIPTION
  341.     "Lists currently outstanding transactions in the net-snmp agent.
  342.      This includes requests to AgentX subagents, or proxied SNMP agents."
  343.     ::= { nsTransactions 1 }
  344.  
  345. nsTransactionEntry OBJECT-TYPE
  346.     SYNTAX      NsTransactionEntry
  347.     MAX-ACCESS  not-accessible
  348.     STATUS      current
  349.     DESCRIPTION
  350.     "A row describing a given transaction."
  351.     INDEX   { nsTransactionID }
  352.     ::= {nsTransactionTable 1 }
  353.  
  354. NsTransactionEntry ::= SEQUENCE {
  355.     nsTransactionID   Unsigned32,
  356.     nsTransactionMode Integer32
  357. }
  358.  
  359. nsTransactionID OBJECT-TYPE
  360.     SYNTAX      Unsigned32 (0..4294967295)
  361.     MAX-ACCESS  not-accessible
  362.     STATUS      current
  363.     DESCRIPTION
  364.     "The internal identifier for a given transaction."
  365.     ::= { nsTransactionEntry 1 }
  366.  
  367. nsTransactionMode OBJECT-TYPE
  368.     SYNTAX      Integer32
  369.     MAX-ACCESS  read-only
  370.     STATUS      current
  371.     DESCRIPTION
  372.     "The mode number for the current operation being performed."
  373.     ::= { nsTransactionEntry 2 }
  374.  
  375.  
  376. --
  377. --  Monitoring the MIB modules currently registered in the agent
  378. --    (an updated version of UCD-SNMP-MIB::mrTable)
  379. --
  380.  
  381. nsModuleTable OBJECT-TYPE
  382.     SYNTAX    SEQUENCE OF NsModuleEntry
  383.     MAX-ACCESS    not-accessible
  384.     STATUS    current
  385.     DESCRIPTION
  386.     "A table displaying all the oid's registered by mib modules in
  387.      the agent.  Since the agent is modular in nature, this lists
  388.      each module's OID it is responsible for and the name of the module"
  389.     ::= { nsMibRegistry 1 }
  390.  
  391. nsModuleEntry OBJECT-TYPE
  392.     SYNTAX    NsModuleEntry
  393.     MAX-ACCESS    not-accessible
  394.     STATUS    current
  395.     DESCRIPTION
  396.         "An entry containing a registered mib oid."
  397.     INDEX       { nsmContextName, nsmRegistrationPoint, 
  398.                   nsmRegistrationPriority }
  399.     ::= { nsModuleTable 1 }
  400.  
  401. NsModuleEntry ::= SEQUENCE {
  402.     nsmContextName          SnmpAdminString,
  403.     nsmRegistrationPoint    OBJECT IDENTIFIER,
  404.     nsmRegistrationPriority INTEGER,
  405.     nsModuleName        DisplayString,
  406.     nsModuleModes           BITS,
  407.     nsModuleTimeout         Integer32
  408. }
  409.  
  410. nsmContextName OBJECT-TYPE
  411.     SYNTAX      SnmpAdminString
  412.     MAX-ACCESS  not-accessible
  413.     STATUS      current
  414.     DESCRIPTION
  415.     "The context name the module is registered under."
  416.     ::= { nsModuleEntry 1 }
  417.  
  418. nsmRegistrationPoint OBJECT-TYPE
  419.     SYNTAX    OBJECT IDENTIFIER
  420.     MAX-ACCESS    not-accessible
  421.     STATUS    current
  422.     DESCRIPTION
  423.     "The registry OID of a mib module."
  424.     ::= { nsModuleEntry  2 }
  425.  
  426. nsmRegistrationPriority OBJECT-TYPE
  427.     SYNTAX    INTEGER (-2147483648..2147483647)
  428.     MAX-ACCESS    not-accessible
  429.     STATUS    current
  430.     DESCRIPTION
  431.     "The priority of the registered mib module."
  432.     ::= { nsModuleEntry  3 }
  433.  
  434. nsModuleName OBJECT-TYPE
  435.     SYNTAX    DisplayString
  436.     MAX-ACCESS    read-only
  437.     STATUS    current
  438.     DESCRIPTION
  439.     "The module name that registered this OID."
  440.     ::= { nsModuleEntry  4 }
  441.  
  442. nsModuleModes OBJECT-TYPE
  443.     SYNTAX    BITS { getAndGetNext(0), set(1), getBulk(2) }
  444.     MAX-ACCESS    read-only
  445.     STATUS    current
  446.     DESCRIPTION
  447.     "The modes that the particular lower level handler can cope
  448.        with directly."
  449.     ::= { nsModuleEntry  5 }
  450.  
  451. nsModuleTimeout OBJECT-TYPE
  452.     SYNTAX    Integer32
  453.     MAX-ACCESS    read-only
  454.     STATUS    current
  455.     DESCRIPTION
  456.     "The registered timeout.  This is only meaningful for handlers
  457.      that expect to return results at a later date (subagents,
  458.      etc)"
  459.     ::= { nsModuleEntry  6 }
  460.  
  461.  
  462. --
  463. --  Notifications relating to the basic operation of the agent
  464. --
  465.  
  466. nsNotifyStart        NOTIFICATION-TYPE
  467.     STATUS    current
  468.     DESCRIPTION
  469.     "An indication that the agent has started running."
  470.     ::= { netSnmpNotifications 1 }
  471.     
  472. nsNotifyShutdown     NOTIFICATION-TYPE
  473.     STATUS current
  474.     DESCRIPTION
  475.     "An indication that the agent is in the process of being shut down."
  476.     ::= { netSnmpNotifications 2 }
  477.  
  478. nsNotifyRestart      NOTIFICATION-TYPE
  479.     STATUS    current
  480.     DESCRIPTION
  481.     "An indication that the agent has been restarted.
  482.      This does not imply anything about whether the configuration has
  483.      changed or not (unlike the standard coldStart or warmStart traps)"
  484.     ::= { netSnmpNotifications 3 }
  485.     
  486.  
  487. --
  488. -- Conformance-related definitions
  489. --
  490.  
  491. nsModuleGroup  OBJECT-GROUP
  492.     OBJECTS {
  493.         nsModuleName, nsModuleModes, nsModuleTimeout
  494.     }
  495.     STATUS    current
  496.     DESCRIPTION
  497.     "The objects relating to the list of MIB modules registered
  498.      with the Net-SNMP agent."
  499.     ::= { netSnmpGroups 2 }
  500.  
  501. nsCacheGroup  OBJECT-GROUP
  502.     OBJECTS {
  503.         nsCacheDefaultTimeout, nsCacheEnabled,
  504.         nsCacheTimeout,        nsCacheStatus
  505.     }
  506.     STATUS    current
  507.     DESCRIPTION
  508.     "The objects relating to data caching in the Net-SNMP agent."
  509.     ::= { netSnmpGroups 4 }
  510.  
  511. nsConfigGroups OBJECT IDENTIFIER ::= {netSnmpGroups 7}
  512.  
  513. nsDebugGroup  OBJECT-GROUP
  514.     OBJECTS {
  515.         nsDebugEnabled, nsDebugOutputAll, nsDebugDumpPdu,
  516.         nsDebugTokenStatus
  517.     }
  518.     STATUS    current
  519.     DESCRIPTION
  520.     "The objects relating to debug configuration in the Net-SNMP agent."
  521.     ::= { nsConfigGroups 1 }
  522.  
  523. nsLoggingGroup  OBJECT-GROUP
  524.     OBJECTS {
  525.         nsLogType, nsLogMaxLevel, nsLogStatus
  526.     }
  527.     STATUS    current
  528.     DESCRIPTION
  529.     "The objects relating to logging configuration in the Net-SNMP agent."
  530.     ::= { nsConfigGroups 2 }
  531.  
  532. nsTransactionGroup  OBJECT-GROUP
  533.     OBJECTS {
  534.         nsTransactionMode
  535.     }
  536.     STATUS    current
  537.     DESCRIPTION
  538.     "The objects relating to transaction monitoring in the Net-SNMP agent."
  539.     ::= { netSnmpGroups 8 }
  540.  
  541. nsAgentNotifyGroup NOTIFICATION-GROUP
  542.     NOTIFICATIONS { nsNotifyStart, nsNotifyShutdown, nsNotifyRestart }
  543.     STATUS    current
  544.     DESCRIPTION
  545.     "The notifications relating to the basic operation of the Net-SNMP agent."
  546.     ::= { netSnmpGroups 9 }
  547.  
  548.     
  549.  
  550. END
  551.